/*
 * Copyright (c) 2011-2012 Alexander Dubu
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * o  Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * o  Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * o  Neither the name Axil nor the names of its contributors may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package axil.framework.collection;

import axil.etc.Identity;

import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;

import static axil.framework.Functions.abort;
import static axil.framework.Functions.nv;


/**
 * A map for objects implementing the Identity interface.
 */
public class IdentityMap<T extends Identity> {
	private final Map<String,T> map;


	public IdentityMap(T... values) {
		this.map = new HashMap<String, T>(values.length);
		for (T v : values) {
			map.put(v.identity(), v);
		}
	}


	public IdentityMap(Collection<T> values) {
		this.map = new HashMap<String, T>(values.size());
		for (T v : values) {
			map.put(v.identity(), v);
		}
	}


	/**
	 * Get the size of this collection.
	 */
	public int size() {
		return map.size();
	}


	/**
	 * Returns true if this collection contains the specified object. The object
	 * given is the value, not the key.
	 */
	public boolean contains(Object object) {
		return map.containsValue(object);
	}


	public boolean contains(String key) {
		return map.containsKey(key);
	}


	public T at(String key) {
		T t = map.get(key);
		if (t == null) {
			throw abort("There is no object with that key.", nv("key", key));
		}
		return t;
	}


	/**
	 * Returns an iterator over a set of elements of type T.
	 */
	public Iterator<T> iterator() {
		return new SafeIterator<T>(map.values());
	}
}
